package org.benben.shortlink.admin.service;

import com.baomidou.mybatisplus.extension.service.IService;
import org.benben.shortlink.admin.dao.entity.UserDO;
import org.benben.shortlink.admin.dto.req.UserLoginReqDTO;
import org.benben.shortlink.admin.dto.req.UserRegisterReqDTO;
import org.benben.shortlink.admin.dto.req.UserUpdateReqDTO;
import org.benben.shortlink.admin.dto.resp.UserLoginRespDTO;
import org.benben.shortlink.admin.dto.resp.UserRespDTO;

/**
 * 用户接口层
 *
 * @author benben
 */
public interface UserService extends IService<UserDO> {

    /**
     * 根据用户名查询用户信息
     *
     * @param username 用户名
     * @return 用户返回实体
     */
    UserRespDTO getUserByUsername(String username);

    /**
     * 判断用户名是否可用
     *
     * @param username 用户名
     * @return 用户名可用返回 True，不可用返回 False
     */
    Boolean hasUsername(String username);

    /**
     * 注册用户
     *
     * @param requestParam 用户注册请求参数
     */
    void register(UserRegisterReqDTO requestParam);

    /**
     * 更新用户信息
     *
     * @param requestParam 用户更新请求参数
     */
    void update(UserUpdateReqDTO requestParam);

    /**
     * 用户登录
     *
     * @param requestParam 用户登录请求参数
     * @return 用户响应对象
     */
    UserLoginRespDTO login(UserLoginReqDTO requestParam);

    /**
     * 根据Token检查用户是否登录
     *
     * @param username 登陆用户名
     * @param token    登录用户Token
     * @return 用户是否登录标志
     */
    Boolean checkLogin(String username, String token);

    /**
     * 用户注销
     *
     * @param username 登陆用户名
     * @param token    登录用户Token
     */
    void logout(String username, String token);

}
